API Documentation
Public Member Functions | List of all members
nkWinUi::ContextMenu Class Referenceabstract

A graphical context menu. More...

Inheritance diagram for nkWinUi::ContextMenu:
nkExport::Exportable

Public Member Functions

 ContextMenu ()
 
virtual ~ContextMenu ()
 
ComponentgetParentComponent () const
 
void setParentComponent (Component *parent)
 
virtual void addItem (const char *itemLabel, int attachedIndex)=0
 
virtual void addSeparator ()=0
 
virtual int showMenu (int absX, int absY)=0
 
virtual void exportClassToTree (nkExport::Node *rootNode) override
 
virtual void importClassFromTree (nkExport::Node *rootNode) override
 
- Public Member Functions inherited from nkExport::Exportable
 Exportable ()
 
virtual ~Exportable ()
 

Detailed Description

A graphical context menu.

Constructor & Destructor Documentation

◆ ContextMenu()

nkWinUi::ContextMenu::ContextMenu ( )

Constructor.

◆ ~ContextMenu()

virtual nkWinUi::ContextMenu::~ContextMenu ( )
virtual

Destructor.

Member Function Documentation

◆ getParentComponent()

Component* nkWinUi::ContextMenu::getParentComponent ( ) const
Returns
The parent component of the context menu.

◆ setParentComponent()

void nkWinUi::ContextMenu::setParentComponent ( Component parent)

Sets the parent component of the context menu.

Parameters
parentThe parent component to attach.

◆ addItem()

virtual void nkWinUi::ContextMenu::addItem ( const char *  itemLabel,
int  attachedIndex 
)
pure virtual

Adds an item, linking it to an index. In the menu, items appear in the order they are declared.

Parameters
itemLabelThe label of the item to create.
attachedIndexThe index the entry should have. Will be used to identify the entry during a callback.

◆ addSeparator()

virtual void nkWinUi::ContextMenu::addSeparator ( )
pure virtual

Adds a separator.

◆ showMenu()

virtual int nkWinUi::ContextMenu::showMenu ( int  absX,
int  absY 
)
pure virtual

Makes the menu pop.

Parameters
absXThe absolute x position of the menu.
absYThe absolute y position of the menu.
Returns
The index of the item the user clicked while the menu was shown.

◆ exportClassToTree()

virtual void nkWinUi::ContextMenu::exportClassToTree ( nkExport::Node rootNode)
overridevirtual

Basic export capability.

Parameters
rootNodeThe root of the tree to populate.

Implements nkExport::Exportable.

◆ importClassFromTree()

virtual void nkWinUi::ContextMenu::importClassFromTree ( nkExport::Node rootNode)
overridevirtual

Basic import capability.

Parameters
rootNodeThe root of the tree to import from.

Implements nkExport::Exportable.


The documentation for this class was generated from the following file: